home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games: 500 MB Amiga Software / 500 MB Amiga Software - Euber 130 - Amiga Games Disc & Mag.iso / userbox / publicdomain / ncomm / doc / host.doc < prev    next >
Text File  |  1991-08-09  |  18KB  |  451 lines
  1.                 ===============================
  2.                 NComm Host Script Documentation
  3.                 ===============================
  4.            Doc ver 3, for script 2.10E, date 90-10-14
  5.           Revision 3.1, extended for 2.11E, 90-11-01
  6.           Revision 3.2, small revisions for 2.11aE, 91-03-19
  7.  
  8.    The NComm Host Script was written by Daniel Bloch 1989.
  9.  The NComm Host Script eXtended (ver 2.00Enad/2.00nad and up) was written
  10.               by Nils-Arne Dahlberg 1990 and 1991
  11.    Documentation written by Torkel Lodberg and Nils-Arne Dahlberg
  12.  
  13.  
  14.     This is an informal version of the third "official" english release, the
  15. things that have changed since 2.06E are not many, but some nasty bugs have
  16. been removed. Compared with 2.10E there are two changes:
  17.     I've include a simple questionare for first-time users, and added a
  18. possibility to just let some users upload files to the BBS.
  19.  
  20.     For more info about them, see the script. The new features are described
  21. later in this document. I have also made some corrections (sigh) from the
  22. earlier version.
  23.  
  24.     The original plan was to implement the NComm host mode as a part of the
  25. NComm program, but, since the program would grow _large_, the host mode was
  26. implemented as a script. Of course, the NComm script language had to be
  27. enhanced, and functions specifically needed for the project were
  28. implemented. The result is one of the most powerful host modes available by
  29. any communication program...
  30.  
  31.                 How to set up NHS
  32.                 =================
  33.  
  34.     Before setting up NHS, please assure that the following files are
  35. available; 'C:LIST', 'C:DELETE', 'C:FILENOTE', 'C:EXECUTE', 'C:COPY' and
  36. one of 'LHarc', 'Arc', or 'Zoo'.
  37.  
  38.     To set up NHS, a few changes have to be made to the 'host.script'. All
  39. variables that need to be maintained have been placed at top of the script.
  40. First, a few directory names have to be defined. All directory names should
  41. end with a colon or a slash, and the directories must exist before you
  42. start using the script.
  43.  
  44.     The variable '$dir' shall contain the name of the directory where all
  45. miscellaneous files are kept. In other words, this is where bulletins,
  46. menus, messages, textfiles and so on have to rely. The NComm Host Script
  47. will log all user operations in a log file that will be created in this
  48. directory.
  49.  
  50.     The variables $menudir, $bulldir and $msgsdir should point at
  51. directories containing menus, bulletins and messages, respectively.
  52.  
  53.     The variables $userdir and $userqst should point at the directories
  54. containing user information and answers to user questionaries,
  55. respectively.
  56.  
  57.     The variable $bulldir should point to a directory where all bulletins
  58. are stored.
  59.  
  60.     The variable '$uldir' shall contain the name of the NHS upload
  61. directory - all files uploaded will be placed here.
  62.  
  63.     The variable '$dldir' shall contain the name of the NHS download
  64. directory - copy the files which shall be available for download
  65. into this directory. Use the CLI command 'FILENOTE' for adding file
  66. descriptions. If '$uldir' and '$dldir' point to the same directory,
  67. files uploaded will be available for download immediately. Otherwise,
  68. the files have to be moved to the '$dldir' directory.
  69.  
  70.     The variables '$apack', '$alist' and '$aextract' must be set to the
  71. archive program's pack, list end extract commands. The variable '$arch'
  72. should contain the program's default extension.
  73.  
  74.     The variable '$hold' shall contain the name of the NHS hold directory.
  75. All ZOO files extracted will be placed in this directory. Please notice
  76. that existing HOLD files wil be deleted at initialization, do not store
  77. other files in this directory!
  78.  
  79.     Now, a few file names have to be defined. The variable '$holdzoo'
  80. shall contain the name of the temporary hold ZOO file. Files will be
  81. added to this file.
  82.  
  83.     The variable '$tmp' shall contain the name of the temporary text file
  84. used by NHS for file listings and so on.
  85.  
  86.     The variable '$sysop' shall contain the directory containing sysop's
  87. name and password.
  88.  
  89.     The variable '$cosysop' is the directory that contains all cosysop's
  90.     names.
  91.  
  92.     The variable '$sysname' shall contain the name of your system.
  93.  
  94.     The variable '$doscomm' should contain the directory where the
  95. dos commands that sysop sand cosysops can execute from remote, are placed.
  96.  
  97.     Specify the name of the directory lister in the variable '$list'.  This
  98. will normally be C:List.
  99.  
  100.     The variable '$maxbaud' is to be set to your modems maximum baudrate.
  101.  
  102.     Finally, set the variable '$hostMNPARQ' to "FALSE" if your modem,
  103. doesn't support MNP or ARQ error correction. If you are not sure, set it to
  104. "FALSE".
  105.  
  106.     A few changes also have to be made to the NComm configuration.
  107. End-Of-Line TX should be set to CR+LF, the character set should be set to
  108. ISO and G&R Host Mode has to be ENABLED. You should use a two colour screen
  109. for faster screen updates. The G&R download dir MUST be set to the directory
  110. specified in the variable '$dldir'. This is due to Zmodem downloads always
  111. being created in the current download directory. Save the configuration as
  112. "host.config" and place it in the directory used for miscellaneous files. A
  113. sample configuration file has been included.
  114.  
  115.     NHS will display two files at logon. The file "prelog" contains the
  116. actual login text, "postlog" will be displayed after a successful login...
  117. And at the logout NHS will show the file 'logout'. When a new user is
  118. loging on, the file 'NewUser' is displayed. Edit them to suit your needs.
  119.  
  120.     All menus are stored as textfiles. The file "menu0" contains the main
  121. menu, "menu1" contains a list of file transfer commands, "menu3" contains
  122. the SYSOP commands, "menu4" is the private mail menu and finally "menu5" is
  123. the messages areas menu. Example files have been included.
  124.     The second menu-choice is taken from files named .menu0, .menu1,
  125. .menu2, .menu4 and .menu5. There is no .menu3 because the sysop menu
  126. is not reached by more than one or two users anyway.
  127.  
  128.     To install bulletins, simply create files "bull0", "bull1" and so on.
  129. You must also remember to edit the bulletin menu, which is contained in the
  130. text file "menu2". Again, example files have been included.
  131.  
  132.                         Modem Setup
  133.                         ===========
  134.     You might have to change line 194 in the script so your modem is
  135. initialized in the right way.
  136.     NHSx needs result codes (V1) and all resultcodes (X4). You also have
  137. to turn off autoanswer (S0=0).
  138.  
  139.                 Using the NComm Host Script
  140.                 ===========================
  141.  
  142.     Execute the 'host.script' using the Execute Script function. If all
  143. files and directories have been created successfully, the modem will be
  144. initialized and a small menu will appear on screen. You may enter 'SPACE'
  145. for logging on locally. The 'R'-command is for testing the remote/local
  146. check that is included for sysops. Remember to turn off the modem before
  147. logging on locally, otherwise the text will be echoed back from the modem.
  148.  
  149.     The NComm Host Script does not support Page Break, so use CTRL-S and
  150. CTRL-Q for halting / resuming text output.
  151.  
  152.     When logging in, the file 'prelog' will be displayed. The host will now
  153. prompt you for your name. Log on with your SYSOP name if you want to gain
  154. SYSOP privileges, or use another name to log on as a user. Enter the
  155. password that has been configured in the "host.script" file at the
  156. 'Password' prompt. The second time you enter an uncorrect password, you
  157. will be thrown off the board. You will also be thrown off the board after 5
  158. minutes of inactivity. If you used the correct password, the file 'postlog'
  159. will be displayed...
  160.  
  161.     Press 'Enter' to continue - NHS will now display the main menu. Here is
  162. a description of the different commands available;
  163.  
  164. MAIN MENU                                                  File; "menu0"
  165. ========================================================================
  166. <B>     Bulletins
  167.                         Displays  the  bulletin  menu.  A description of
  168.                         bulletin menu commands follows further down.
  169.  
  170. <C>     Comments to sysop
  171.                         Enters  comment  into system.  Prompts you for a
  172.                         subject.   You  will  then  enter  a simple line
  173.                         editor  that  must  be  used  for  entering your
  174.                         comment.   Press  CTRL-Z  on  a  blank line when
  175.                         finished.  The message will be added to the file
  176.                         'comments'  -  it can be read by using the SYSOP
  177.                         command [R]ead private messages.
  178.  
  179. <E>     Read and Write private messages
  180.                         Goto the Private Mail menu.
  181.  
  182. <F>     File-menu
  183.                         Displays  the  file menu.  A description of file
  184.                         menu commands follows further down.
  185.  
  186. <G>     Log out
  187.                         Brings up a prompt asking you if you want to log
  188.                         off  the  system or not.  The hangup string will
  189.                         be  sent to the modem if the answer is positive.
  190.                         NHS will start waiting for the next caller.
  191.  
  192. <L>     List Users
  193.                         Prints a list of all users, and their status.
  194.                         The status is written into the textfile and can be
  195.                         changed by the sysop. The status has no effect
  196.                         on the program.
  197.  
  198. <M>     Messages menu
  199.                         Jump to a submenu for messages.
  200.  
  201. <O>     Page operator
  202.                         Will  ring  the bell for SYSOP at local console.
  203.                         When  chatting,  you may return to the main menu
  204.                         by pressing CTRL-Z.
  205.  
  206. <P>     Change Password
  207.                         Used if you want to change your password. You are
  208.                         asked to input it twice to make sure that you
  209.                         haven't made any spelling mistakes.
  210.  
  211. (S)     Sysop functions
  212.                         Only available for SYSOP and cosysop. Displays
  213.                         the SYSOP menu. A description of SYSOP menu
  214.                         commands follows further down.
  215.                         This entry isn't in the menu, but it still works.
  216.  
  217.  
  218. <V>     View version number
  219.                         Outputs the current version of the script. It
  220.                         was actually first just placed there for testing
  221.                         purposes, but it's easier to leave it than risk
  222.                         messing things up by removing it...
  223.  
  224. FILE MENU                                                  File; "menu1"
  225. ========================================================================
  226.  
  227. <ADD> file to HOLD
  228.                             Prompts  you  for  a filename. The file will
  229.                             be added to the HOLD directory.
  230.  
  231. <DIR> List files in HOLD
  232.                             Displays the contents of the HOLD directory.
  233.  
  234. <EXT>ract packed file to HOLD
  235.                             Prompts you  for  a  filename. The file must
  236.                             have  the extension $arch. The file will be
  237.                             extracted into the HOLD directory.
  238.  
  239. <DEL>ete file(s) from HOLD
  240.                             Prompts you for a filename. The file will be
  241.                             deleted from the HOLD directory.
  242.  
  243. <GET> files in HOLD
  244.                             Packs  the  contents  of  the HOLD directory
  245.                             into the hold packed  file. The command will
  246.                             prompt   you   for  the  preferred  transfer
  247.                             protocol (Xmodem / YModem / Zmodem /
  248.                             Ymodem-Batch / YModem-G), and the transfer
  249.                             will start.
  250.  
  251. <L>ist files
  252.                             Lists the contents of the download directory
  253.                             using  the  command specified in the '$list'
  254.                             variable.
  255.  
  256. <D>ownload file
  257.                             Prompts  you  for  a  filename  and transfer
  258.                             protocol (Xmodem / YModem / Zmodem /
  259.                             Ymodem-Batch / YModem-G), and the transfer
  260.                             will start.
  261.  
  262. <U>pload file
  263.                             Prompts  you  for  a  filename  and transfer
  264.                             protocol (Xmodem / YModem / Zmodem /
  265.                             Ymodem-Batch / YModem-G), and the transfer
  266.                             will start.
  267.  
  268. <V>iew packed file
  269.                             Prompts  you  for  a filename. The filename
  270.                             must include the extension . The contents of
  271.                             the file will be displayed on screen.
  272.  
  273. <Q>uit
  274.                             Quits to main menu.
  275.  
  276.  
  277.  
  278. BULLETIN MENU                                              File; "menu2"
  279. ========================================================================
  280.  
  281. <xx>
  282.          Displays bulletin #xx on screen. The file 'BULLxx' must exist.
  283.  
  284. <Enter> or <Q>
  285.          Quits to main menu.
  286.  
  287.  
  288. SYSOP MENU                                                 File; "menu3"
  289. ========================================================================
  290.  
  291. <B>ackup
  292.                          Starts a remote backup-sequence.
  293.  
  294. <R>ead private messages
  295.                          Displays  the  file  'comments' on screen.  All
  296.                          user comments are contained here.
  297.  
  298. <L>ist user log
  299.                          Displays the file 'log' on screen. The log file
  300.                          contains  a  list  of  all user operations that
  301.                          have been made.
  302.  
  303. <D>elete user log
  304.                          Asks for a confirm. Deletes the file 'log' from
  305.                          disk and creates a blank log file.
  306.  
  307. <C>omments delete
  308.                          Asks for a confirm. Deletes the file 'comments'
  309.                          from disk and creates a blank comments file.
  310.  
  311. <Q>uit to main menu
  312.                          Quits to main menu.
  313.  
  314. <S>tart another script
  315.                          Starts another script, just an experimental thing.
  316.  
  317.  
  318. In addition to this, you can enter a DOS-command which will be executed and
  319. the result will be displayed on screen. Which commands you can execute,
  320. depends on the script setup. (See above.)
  321.  
  322. Private Mail                                         Menu4;
  323. ==================================================================
  324. <Q>  To Main menu
  325.                         Quits to main menu.
  326.  
  327. <R>  Read letters to you
  328.                         Read the letters to you.
  329.  
  330. <W>  Write a letter to someone
  331.                         Write a letter to someone. You have to input the
  332.                         name of the reciver and a subject. You  will
  333.                         then enter a simple line editor that must be used
  334.                         for  entering your message. Press CTRL-Z on a
  335.                         blank line when finished. The message will be
  336.                         added to the file '<receiversname>' - it can be
  337.                         read by using the command <R>ead letters.
  338.  
  339. <E>  Erase all letters to you
  340.                         Ask for confirmation and if ok, erases yor messages
  341.                         file.
  342.  
  343. <G>  Grab all messages and letters in a file
  344.                         First, copies your messages to hold, and asks if the
  345.                         same shall be done with area messages and bulletins.
  346.                         The messages are packed and sent as a binary file.
  347.  
  348. Boringtowns BBSs Areamenu:
  349. ==========================
  350. <xx> Different message areas
  351.  
  352. <R> Read messages
  353.                         Asks for the correct area and sends the file.
  354.  
  355. <W> Write messages
  356.                         Asks for area and receiver of message. After
  357.                         that you are asked to input a subject. The message-
  358.                         entering is done in the same way as comment to
  359.                         sysop. (See above)
  360. <Q> Back to Main menu
  361.                         You should know this by now, really.
  362.  
  363.  
  364.   Some new features (2.10)
  365.  
  366.     If you want another program to stop NHSx, without just throwing a
  367. possible user away, do it this way:
  368.     Let the program create a file called "RAM:C/NHSQUIT" and place the
  369. delete command in ram:c. Then you just let the program wait until the file
  370. "RAM:C/NHSQUIT" doesn't exists and go on after that. One possible use of this
  371. is if you want to use your computer for automatic phone- calls at certain
  372. times (using it as a fido-point or fido-host).
  373.  
  374.     You can, from the sysop menu, now start an ncomm-script. This is purely
  375. exprimental, and you canæt get back to the BBS, but I'll think of some use
  376. :-).
  377.     This script MUST end with the line: CHAIN Host.script to restart
  378. the BBS. An example, do-nothing, script is included.
  379.  
  380.  
  381.  
  382.  
  383. Things changed since version 1.3 of the script is:
  384.  
  385.  * All users have their own password
  386.  
  387.  * Cosysop status added
  388.  
  389.  * All of NComms protocols are supported
  390.  
  391.  * Private messages to/from all users
  392.  
  393.  * Multiple messages areas
  394.  
  395.  * A remote-backup function added
  396.  
  397.  * Possibility to choose archive program by sysop
  398.  
  399. Added since 2.06E
  400.  
  401.  * Possibility to let another program break the script
  402.  
  403.  * The sysop or cosysop can start another script from the sysop menu
  404.    This is just an experimental feature without use, yet...
  405.  
  406. Added since 2.10E
  407.  
  408.  * Possibility to exclude users from upload
  409.  
  410.  * A small questionnaire for first-time users
  411.  
  412.  
  413.     Coming featuers
  414.     ===============
  415.     These things will probably be ShareWare or FreeWare
  416.  
  417.  * A more usefull message handling system (it is actually under beta-testing)
  418.  
  419.     It will contain the usual read Next/Previous, Enter message and Reply
  420. commands. This will be handled by an external program, MessHandle, which will
  421. save the messages in a format readable by ConfMail.
  422.  
  423.  * A better system for user handling
  424.  
  425.  * Multiple file areas
  426.  
  427.  * External programs for User and File handling.
  428.  
  429.  * Maybe a complete Fido-net package.
  430.  
  431.  
  432.  
  433. To get hold of me:
  434. EMail
  435. FidoNet 2:204/417
  436. My own bbs, +46 120 109 75, swedish only
  437. NComm Support BBS (+47 2 493210)
  438.  
  439.  
  440. Snail-Mail:
  441.     Nils-Arne Dahlberg
  442.     Smaellgatan 6A
  443.     S-597 52  AAtvidaberg
  444.     SWEDEN
  445.  
  446. And some credits:
  447. Fido-net is a registred trademark of Tom Jennings
  448. ConfMail is (c) Spark Software, Inc.  (Bob Hartman)
  449. And, if you havn't understod that by now, NComm is (c) Daniel Bloch & Co
  450.  
  451.